Skip to content

chore: add text=true to the broken code examples #2088

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Nov 29, 2024
Merged

chore: add text=true to the broken code examples #2088

merged 1 commit into from
Nov 29, 2024

Conversation

@Delta456
Copy link
Member

@Delta456 Delta456 commented Nov 29, 2024 •
edited by qodo-merge-pro bot
Loading

User description

Thanks for contributing to the Selenium site and documentation!
A PR well described will help maintainers to review and merge it quickly

Before submitting your PR, please check our contributing guidelines.
Avoid large PRs, and help reviewers by making them as simple and short as possible.

Description

Adds text=true to broken code samples

Motivation and Context

I didn't add these in my previous PRs which caused the docs to be broken

Before

image

After

image

Types of changes

  • Change to the site (I have double-checked the Netlify deployment, and my changes look good)
  • Code example added (and I also added the example to all translated languages)
  • Improved translation
  • Added new translation (and I also added a notice to each document missing translation)

Checklist

  • I have read the contributing document.
  • I have used hugo to render the site/docs locally and I am sure it works.

PR Type

documentation

Description

  • Added text=true attribute to Python code tabs across multiple documentation files to ensure consistency and correct rendering.
  • Updated code examples in English, Japanese, Portuguese, and Chinese documentation for both element interactions and cookie interactions.

Changes walkthrough 📝

Relevant files
Documentation
interactions.en.md
Add `text=true` to Python code tabs in interactions.en.md

website_and_docs/content/documentation/webdriver/elements/interactions.en.md

  • Added text=true attribute to Python code tabs.
  • Ensured consistency across code examples.
    		•  +3/-3     
    interactions.ja.md
    Add `text=true` to Python code tabs in interactions.ja.md

    website_and_docs/content/documentation/webdriver/elements/interactions.ja.md

  • Added text=true attribute to Python code tabs.
  • Ensured consistency across code examples.
    		•  +3/-3     
    interactions.pt-br.md
    Add `text=true` to Python code tabs in interactions.pt-br.md

    website_and_docs/content/documentation/webdriver/elements/interactions.pt-br.md

  • Added text=true attribute to Python code tabs.
  • Ensured consistency across code examples.
    		•  +3/-3     
    interactions.zh-cn.md
    Add `text=true` to Python code tabs in interactions.zh-cn.md

    website_and_docs/content/documentation/webdriver/elements/interactions.zh-cn.md

  • Added text=true attribute to Python code tabs.
  • Ensured consistency across code examples.
    		•  +3/-3     
    cookies.en.md
    Add `text=true` to Python code tabs in cookies.en.md         

    website_and_docs/content/documentation/webdriver/interactions/cookies.en.md

  • Added text=true attribute to Python code tabs.
  • Ensured consistency across code examples.
    		•  +9/-9     
    cookies.ja.md
    Add `text=true` to Python code tabs in cookies.ja.md         

    website_and_docs/content/documentation/webdriver/interactions/cookies.ja.md

  • Added text=true attribute to Python code tabs.
  • Ensured consistency across code examples.
    		•  +6/-6     
    cookies.pt-br.md
    Add `text=true` to Python code tabs in cookies.pt-br.md   

    website_and_docs/content/documentation/webdriver/interactions/cookies.pt-br.md

  • Added text=true attribute to Python code tabs.
  • Ensured consistency across code examples.
    		•  +6/-6     
    cookies.zh-cn.md
    Add `text=true` to Python code tabs in cookies.zh-cn.md   

    website_and_docs/content/documentation/webdriver/interactions/cookies.zh-cn.md

  • Added text=true attribute to Python code tabs.
  • Ensured consistency across code examples.
    		•  +6/-6     

    💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

    @netlify
    Copy link

    netlify bot commented Nov 29, 2024 •
    edited
    Loading

    ✅ Deploy Preview for selenium-dev ready!

    Name Link
    🔨 Latest commit e8c2f70
    🔍 Latest deploy log https://app.netlify.com/sites/selenium-dev/deploys/674a0ce5920206000889f78e
    😎 Deploy Preview https://deploy-preview-2088--selenium-dev.netlify.app
    📱 Preview on mobile
    Toggle QR Code...

    QR Code

    Use your smartphone camera to open QR code link.

    To edit notification comments on pull requests, go to your Netlify site configuration.

    @qodo-merge-pro
    Copy link
    Contributor

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ No major issues detected

    @qodo-merge-pro
    Copy link
    Contributor

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Score
    General
    Remove duplicate attributes to prevent potential rendering issues and maintain consistency

    Remove the duplicate text=true attribute in the Python code block to avoid
    redundancy and potential rendering issues.

    website_and_docs/content/documentation/webdriver/interactions/cookies.en.md [190-191]

     {{< tab header="Python" text=true >}}
-{{< gh-codeblock path="examples/python/tests/interactions/test_cookies.py#L35-L43" text=true >}}
+{{< gh-codeblock path="examples/python/tests/interactions/test_cookies.py#L35-L43" >}}
    • Apply this suggestion
    Suggestion importance[1-10]: 7

    Why: The duplicate text=true attribute in the gh-codeblock tag is redundant and could cause rendering issues. Removing it maintains consistency with other code blocks in the documentation.

    		7

    💡 Need additional feedback ? start a PR chat

    harsha509
    harsha509 approved these changes Nov 29, 2024
    View reviewed changes
    Copy link
    Member

    @harsha509 harsha509 left a comment

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    Thank you @Delta456 !

    @harsha509 harsha509 merged commit 3a3c6b9 into SeleniumHQ:trunk Nov 29, 2024
    6 checks passed
    selenium-ci added a commit that referenced this pull request Nov 29, 2024
    @selenium-ci
    chore: add text=true to the broken code examples (#2088)[deploy site]
    bba6916 
    chore: add text=true to the broken code examples 3a3c6b9
    @Delta456 Delta456 deleted the text_true branch December 3, 2024 18:44
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Reviewers

    @harsha509 harsha509 harsha509 approved these changes

    Assignees

    No one assigned

    Labels

    Review effort [1-5]: 1

    Projects

    None yet

    Milestone

    No milestone

    Development

    Successfully merging this pull request may close these issues.

    2 participants

    @Delta456 @harsha509